﻿///////////////////////////////////////////////////////////////////////////////
//
//  This source is part of the  "Managed Task Framework.NET Runtime"  (MTF.NET Runtime).
//
//
//  Copyright (c) 2011, Multicore Consulting Limited (UK)
//  All rights reserved.
//  http://www.multicoreconsulting.co.uk
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  -  Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  -  Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//  -  Neither the name of Multicore Consulting Limited nor the names of
//     its contributors may be used to endorse or promote products
//     derived from this software without specific prior written
//     permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
//  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
//  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
//  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
//  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
//  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
//  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
//  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
///////////////////////////////////////////////////////////////////////////////

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using MTFOrg.MTF.MTFRuntime;
using MTFOrg.MTF.MTFCore;

namespace MTFOrg.MTF.MTFCore.Messages
{
	/// <summary>
	/// Response message containing an event.
	/// </summary>
	public class EventMsg : GenericMsg
	{
		/// <summary>
		/// Link number within the connection on which the query will be sent.
		/// </summary>
		protected int m_LinkNumber;

		/// <summary>
		/// Event associated with this message.
		/// </summary>
		protected Event m_Event;

		/// <summary>
		/// Key provided by the producer to identify this event for later release.
		/// </summary>
		protected int m_ProducerKey;

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="theEvent">Event to attach to this message</param>
		public EventMsg(int elementNumber, int linkNumber, Event theEvent, int producerKey):
			base(elementNumber)
		{
			m_Event = theEvent;
			m_ElementNumber = elementNumber;
			m_LinkNumber = linkNumber;
			m_ProducerKey = producerKey;
		}

		/// <summary>
		/// Gets the link number within the connection on which this quer will
		/// be sent.
		/// </summary>
		public int LinkNumber
		{
			get { return m_LinkNumber; }
		}

		/// <summary>
		/// Gets the event associated with this message.
		/// </summary>
		public Event Event
		{
			get { return m_Event; }
		}

		/// <summary>
		/// Gets the key provided by the producer that enables the event to be released.
		/// </summary>
		public int ProducerKey
		{
			get { return m_ProducerKey; }
		}
	}
}
